Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updated button specification with Icon #37966

Merged

Conversation

narefyev91
Copy link
Contributor

@narefyev91 narefyev91 commented Mar 8, 2024

Details

Updated design for Button component with Icon

Fixed Issues

$ #37089
PROPOSAL: #37089

Tests

  1. Open workspace in which user is an admin
  2. Verify that in profile screen - there 2 buttons with icons
  3. Verify styles
  • Verify that no errors appear in the JS console

Offline tests

  1. Open workspace in which user is an admin
  2. Verify that in profile screen - there 2 buttons with icons
  3. Verify styles

QA Steps

  1. Open workspace in which user is an admin
  2. Verify that in profile screen - there 2 buttons with icons
  3. Verify styles
  • Verify that no errors appear in the JS console

PR Author Checklist

  • I linked the correct issue in the ### Fixed Issues section above
  • I wrote clear testing steps that cover the changes made in this PR
    • I added steps for local testing in the Tests section
    • I added steps for the expected offline behavior in the Offline steps section
    • I added steps for Staging and/or Production testing in the QA steps section
    • I added steps to cover failure scenarios (i.e. verify an input displays the correct error message if the entered data is not correct)
    • I turned off my network connection and tested it while offline to ensure it matches the expected behavior (i.e. verify the default avatar icon is displayed if app is offline)
    • I tested this PR with a High Traffic account against the staging or production API to ensure there are no regressions (e.g. long loading states that impact usability).
  • I included screenshots or videos for tests on all platforms
  • I ran the tests on all platforms & verified they passed on:
    • Android: Native
    • Android: mWeb Chrome
    • iOS: Native
    • iOS: mWeb Safari
    • MacOS: Chrome / Safari
    • MacOS: Desktop
  • I verified there are no console errors (if there's a console error not related to the PR, report it or open an issue for it to be fixed)
  • I followed proper code patterns (see Reviewing the code)
    • I verified that any callback methods that were added or modified are named for what the method does and never what callback they handle (i.e. toggleReport and not onIconClick)
    • I verified that the left part of a conditional rendering a React component is a boolean and NOT a string, e.g. myBool && <MyComponent />.
    • I verified that comments were added to code that is not self explanatory
    • I verified that any new or modified comments were clear, correct English, and explained "why" the code was doing something instead of only explaining "what" the code was doing.
    • I verified any copy / text shown in the product is localized by adding it to src/languages/* files and using the translation method
      • If any non-english text was added/modified, I verified the translation was requested/reviewed in #expensify-open-source and it was approved by an internal Expensify engineer. Link to Slack message:
    • I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
    • I verified any copy / text that was added to the app is grammatically correct in English. It adheres to proper capitalization guidelines (note: only the first word of header/labels should be capitalized), and is approved by marketing by adding the Waiting for Copy label for a copy review on the original GH to get the correct copy.
    • I verified proper file naming conventions were followed for any new files or renamed files. All non-platform specific files are named after what they export and are not named "index.js". All platform-specific files are named for the platform the code supports as outlined in the README.
    • I verified the JSDocs style guidelines (in STYLE.md) were followed
  • If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
  • I followed the guidelines as stated in the Review Guidelines
  • I tested other components that can be impacted by my changes (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar are working as expected)
  • I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
  • I verified any variables that can be defined as constants (ie. in CONST.js or at the top of the file that uses the constant) are defined as such
  • I verified that if a function's arguments changed that all usages have also been updated correctly
  • If any new file was added I verified that:
    • The file has a description of what it does and/or why is needed at the top of the file if the code is not self explanatory
  • If a new CSS style is added I verified that:
    • A similar style doesn't already exist
    • The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(theme.componentBG))
  • If the PR modifies code that runs when editing or sending messages, I tested and verified there is no unexpected behavior for all supported markdown - URLs, single line code, code blocks, quotes, headings, bold, strikethrough, and italic.
  • If the PR modifies a generic component, I tested and verified that those changes do not break usages of that component in the rest of the App (i.e. if a shared library or component like Avatar is modified, I verified that Avatar is working as expected in all cases)
  • If the PR modifies a component related to any of the existing Storybook stories, I tested and verified all stories for that component are still working as expected.
  • If the PR modifies a component or page that can be accessed by a direct deeplink, I verified that the code functions as expected when the deeplink is used - from a logged in and logged out account.
  • If the PR modifies the form input styles:
    • I verified that all the inputs inside a form are aligned with each other.
    • I added Design label so the design team can review the changes.
  • If a new page is added, I verified it's using the ScrollView component to make it scrollable when more elements are added to the page.
  • If the main branch was merged into this PR after a review, I tested again and verified the outcome was still expected according to the Test steps.

Screenshots/Videos

Android: Native

android

Android: mWeb Chrome

android-web

iOS: Native

ios

iOS: mWeb Safari

ios-web

MacOS: Chrome / Safari web
MacOS: Desktop desktop

@luacmartins luacmartins self-requested a review March 8, 2024 14:12
@narefyev91
Copy link
Contributor Author

@Expensify/design please review screens with new icon inside button component
web
ios

@narefyev91 narefyev91 marked this pull request as ready for review March 11, 2024 14:41
@narefyev91 narefyev91 requested a review from a team as a code owner March 11, 2024 14:41
@melvin-bot melvin-bot bot requested review from sobitneupane and removed request for a team March 11, 2024 14:41
Copy link

melvin-bot bot commented Mar 11, 2024

@sobitneupane Please copy/paste the Reviewer Checklist from here into a new comment on this PR and complete it. If you have the K2 extension, you can simply click: [this button]

@shawnborton
Copy link
Contributor

cc @dannymcclain specifically since you made the button component in Figma.

A couple of questions from me:

  • If you don't set any props on the button component, just confirming that the default button we would use is the "medium" version at 40px tall?
  • I believe we're doing something funky in Figma to use slightly less padding on the side of the button that has the icon. Do we want to do that same treatment here? I believe we are just giving the icon wrapper some negative margin or something like that.

@narefyev91
Copy link
Contributor Author

cc @dannymcclain specifically since you made the button component in Figma.

A couple of questions from me:

  • If you don't set any props on the button component, just confirming that the default button we would use is the "medium" version at 40px tall?
  • I believe we're doing something funky in Figma to use slightly less padding on the side of the button that has the icon. Do we want to do that same treatment here? I believe we are just giving the icon wrapper some negative margin or something like that.

@shawnborton

  1. yup now we have fallback for button 40px.
  2. we not having any negative margin now - we just show correct left padding which should be added based on button size and icon (ex from spec)
Screenshot 2024-03-11 at 17 03 56

@shawnborton
Copy link
Contributor

Yup, understood, just noting that in Figma we actually are doing something tricky where we are using a wrapper for the icon that is 4px less wide than the icon itself. This way it gives the visual effect of having 4px less padding on the side that has an icon:
CleanShot 2024-03-11 at 11 10 26@2x

So I think ideally we do this here as well. Not sure how we want to implement it - it might be as simple as just writing in the code that when the button has an icon on the left, take 4px of padding off the left side (and do the same for the right).

@narefyev91
Copy link
Contributor Author

Yup, understood, just noting that in Figma we actually are doing something tricky where we are using a wrapper for the icon that is 4px less wide than the icon itself. This way it gives the visual effect of having 4px less padding on the side that has an icon: CleanShot 2024-03-11 at 11 10 26@2x

So I think ideally we do this here as well. Not sure how we want to implement it - it might be as simple as just writing in the code that when the button has an icon on the left, take 4px of padding off the left side (and do the same for the right).

Yup. That exactly implemented at that way now - if icon is used - we just adding less padding for left - instead of 12 -> 8, instead of 16 -> 12, instead of 20 -> 16

@shawnborton
Copy link
Contributor

Ah okay, that is great - thanks for confirming!

Copy link
Contributor

@luacmartins luacmartins left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code LGTM, but I think we need to apply it to the recently merged tags page too

Copy link
Contributor

@sobitneupane sobitneupane left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Screenshots/Videos

Android: Native Screenshot 2024-03-12 at 16 29 23 Screenshot 2024-03-12 at 16 29 46 Screenshot 2024-03-12 at 16 30 08 Screenshot 2024-03-12 at 16 30 33
Android: mWeb Chrome
iOS: Native Screenshot 2024-03-12 at 16 38 50 Screenshot 2024-03-12 at 16 39 03 Screenshot 2024-03-12 at 16 39 20 Screenshot 2024-03-12 at 16 40 50
iOS: mWeb Safari Screenshot 2024-03-12 at 16 33 43 Screenshot 2024-03-12 at 16 32 49
MacOS: Chrome / Safari Screenshot 2024-03-12 at 13 18 56 Screenshot 2024-03-12 at 13 18 34 Screenshot 2024-03-12 at 13 18 05
MacOS: Desktop Screenshot 2024-03-12 at 16 40 13 Screenshot 2024-03-12 at 16 40 26 Screenshot 2024-03-12 at 16 40 36

@sobitneupane
Copy link
Contributor

sobitneupane commented Mar 12, 2024

Staging This PR
Screenshot 2024-03-12 at 13 18 37 Screenshot 2024-03-12 at 13 18 34
Screenshot 2024-03-12 at 13 18 08 Screenshot 2024-03-12 at 13 18 05
Screenshot 2024-03-12 at 13 23 41 Screenshot 2024-03-12 at 13 23 17

Copy link
Contributor

@sobitneupane sobitneupane left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reviewer Checklist

  • I have verified the author checklist is complete (all boxes are checked off).
  • I verified the correct issue is linked in the ### Fixed Issues section above
  • I verified testing steps are clear and they cover the changes made in this PR
    • I verified the steps for local testing are in the Tests section
    • I verified the steps for Staging and/or Production testing are in the QA steps section
    • I verified the steps cover any possible failure scenarios (i.e. verify an input displays the correct error message if the entered data is not correct)
    • I turned off my network connection and tested it while offline to ensure it matches the expected behavior (i.e. verify the default avatar icon is displayed if app is offline)
  • I checked that screenshots or videos are included for tests on all platforms
  • I included screenshots or videos for tests on all platforms
  • I verified tests pass on all platforms & I tested again on:
    • Android: Native
    • Android: mWeb Chrome
    • iOS: Native
    • iOS: mWeb Safari
    • MacOS: Chrome / Safari
    • MacOS: Desktop
  • If there are any errors in the console that are unrelated to this PR, I either fixed them (preferred) or linked to where I reported them in Slack
  • I verified proper code patterns were followed (see Reviewing the code)
    • I verified that any callback methods that were added or modified are named for what the method does and never what callback they handle (i.e. toggleReport and not onIconClick).
    • I verified that the left part of a conditional rendering a React component is a boolean and NOT a string, e.g. myBool && <MyComponent />.
    • I verified that comments were added to code that is not self explanatory
    • I verified that any new or modified comments were clear, correct English, and explained "why" the code was doing something instead of only explaining "what" the code was doing.
    • I verified any copy / text shown in the product is localized by adding it to src/languages/* files and using the translation method
    • I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
    • I verified any copy / text that was added to the app is grammatically correct in English. It adheres to proper capitalization guidelines (note: only the first word of header/labels should be capitalized), and is either coming verbatim from figma or has been approved by marketing (in order to get marketing approval, ask the Bug Zero team member to add the Waiting for copy label to the issue)
    • I verified proper file naming conventions were followed for any new files or renamed files. All non-platform specific files are named after what they export and are not named "index.js". All platform-specific files are named for the platform the code supports as outlined in the README.
    • I verified the JSDocs style guidelines (in STYLE.md) were followed
  • If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
  • I verified that this PR follows the guidelines as stated in the Review Guidelines
  • I verified other components that can be impacted by these changes have been tested, and I retested again (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar have been tested & I retested again)
  • I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
  • I verified any variables that can be defined as constants (ie. in CONST.js or at the top of the file that uses the constant) are defined as such
  • If a new component is created I verified that:
    • A similar component doesn't exist in the codebase
    • All props are defined accurately and each prop has a /** comment above it */
    • The file is named correctly
    • The component has a clear name that is non-ambiguous and the purpose of the component can be inferred from the name alone
    • The only data being stored in the state is data necessary for rendering and nothing else
    • For Class Components, any internal methods passed to components event handlers are bound to this properly so there are no scoping issues (i.e. for onClick={this.submit} the method this.submit should be bound to this in the constructor)
    • Any internal methods bound to this are necessary to be bound (i.e. avoid this.submit = this.submit.bind(this); if this.submit is never passed to a component event handler like onClick)
    • All JSX used for rendering exists in the render method
    • The component has the minimum amount of code necessary for its purpose, and it is broken down into smaller components in order to separate concerns and functions
  • If any new file was added I verified that:
    • The file has a description of what it does and/or why is needed at the top of the file if the code is not self explanatory
  • If a new CSS style is added I verified that:
    • A similar style doesn't already exist
    • The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(theme.componentBG)
  • If the PR modifies code that runs when editing or sending messages, I tested and verified there is no unexpected behavior for all supported markdown - URLs, single line code, code blocks, quotes, headings, bold, strikethrough, and italic.
  • If the PR modifies a generic component, I tested and verified that those changes do not break usages of that component in the rest of the App (i.e. if a shared library or component like Avatar is modified, I verified that Avatar is working as expected in all cases)
  • If the PR modifies a component related to any of the existing Storybook stories, I tested and verified all stories for that component are still working as expected.
  • If the PR modifies a component or page that can be accessed by a direct deeplink, I verified that the code functions as expected when the deeplink is used - from a logged in and logged out account.
  • If the PR modifies the form input styles:
    • I verified that all the inputs inside a form are aligned with each other.
    • I added Design label so the design team can review the changes.
  • If a new page is added, I verified it's using the ScrollView component to make it scrollable when more elements are added to the page.
  • If the main branch was merged into this PR after a review, I tested again and verified the outcome was still expected according to the Test steps.
  • I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.

@melvin-bot melvin-bot bot requested a review from luacmartins March 12, 2024 11:01
@sobitneupane
Copy link
Contributor

@luacmartins I have listed few changes #37966 (comment)

@luacmartins
Copy link
Contributor

@Expensify/design could you please take a look at these changes? Do they seem correct? #37966 (comment)

luacmartins
luacmartins previously approved these changes Mar 12, 2024
@dannymcclain
Copy link
Contributor

I think you guys have landed on the best approach to this. Feels the least risky while also setting things up the way we want them to be. Go team!

Copy link
Contributor

@shawnborton
Copy link
Contributor

This seems to test pretty well to me! I poked around the app and everything looks normal.

One tiny tiny request - can you replace our 20x20 QR code icon with this one? qrcode.svg.zip

cc @Expensify/design - I think the one in product is an old export that doesn't have any negative space around the icon shape, so it feels beefy compared to what's in Figma:

CleanShot 2024-03-12 at 15 29 37@2x

Figma for reference:
CleanShot 2024-03-12 at 15 30 11@2x

Copy link
Contributor

@luacmartins luacmartins left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just missing Shawn's comment and resolving conflicts

# Conflicts:
#	src/pages/NewChatPage.tsx
#	src/pages/workspace/tags/WorkspaceTagsPage.tsx
@narefyev91
Copy link
Contributor Author

@luacmartins @shawnborton conflicts fixed, icon is updated
Screenshot 2024-03-13 at 09 55 18

@shawnborton
Copy link
Contributor

Looks great, thanks!

@shawnborton
Copy link
Contributor

In the PR screenshots, can we be sure to include all of the various button types? So including split buttons, buttons that have an icon to the right and not the left, buttons with no icons, etc. Thanks!

@narefyev91
Copy link
Contributor Author

In the PR screenshots, can we be sure to include all of the various button types? So including split buttons, buttons that have an icon to the right and not the left, buttons with no icons, etc. Thanks!

I will post one global here for all possible cases:
Screenshot 2024-03-13 at 16 44 55

@shawnborton
Copy link
Contributor

Nice, that feels pretty good to me.

@dannymcclain
Copy link
Contributor

Same!

# Conflicts:
#	src/pages/workspace/categories/WorkspaceCategoriesPage.tsx
@luacmartins luacmartins merged commit 2d32f2f into Expensify:main Mar 13, 2024
18 checks passed
@OSBotify
Copy link
Contributor

✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release.

@OSBotify
Copy link
Contributor

🚀 Deployed to staging by https://github.com/luacmartins in version: 1.4.52-0 🚀

platform result
🤖 android 🤖 success ✅
🖥 desktop 🖥 success ✅
🍎 iOS 🍎 success ✅
🕸 web 🕸 success ✅

@shubham1206agra
Copy link
Contributor

@narefyev91 You forgot to configure Add stop button in DistanceRequestFooter, which is causing #38266

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/Beamanator in version: 1.4.52-6 🚀

platform result
🤖 android 🤖 success ✅
🖥 desktop 🖥 success ✅
🍎 iOS 🍎 success ✅
🕸 web 🕸 success ✅

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants